◀ Prev · Parts · Full · Next ▶

Programmers often use one of select words – also known as tags, codetagscite-ref-37[37]cite-ref-38[38] and tokenscite-ref-39[39] – to categorize the information in a comment. Programmers may leverage these tags by searching for them via a text editor or grep. Some editors highlight comment text based on tags.

Commonly used tags include:

• BUG, DEBUG — identifies a known bug; maybe implying it should be fixed

• FIXME — implies that there is work to do to fix a bug

• HACK, BODGE, KLUDGE — marks a solution that might be considered low quality

• TODO — describes some work to do

• NOTE — relatively general information

• UNDONE — a reversal or "roll back" of previous code

For example:

◀ Prev · Parts · Full · Next ▶